Esx Settings Depots Offline HostCredentials

The Esx Settings Depots Offline HostCredentials schema contains properties that describe the host's username, password, port number, ssl thumbprint or ssl certificate to be used when connecting to the host using USERNAME_PASSWORD option in the Esx Settings Depots Offline ConnectionSpec AuthenticationType enumerated type.

This schema was added in vSphere API 7.0.2.0.

JSON Example

{
    "host_name": "string",
    "user_name": "string",
    "password": "string",
    "port": 0,
    "ssl_thumb_print": "string",
    "ssl_certificate": "string"
}

string

host_name

Required

The IP address or DNS resolvable name of the host.

This property was added in vSphere API 7.0.2.0.

string

user_name

Required

Specifies the username to be used during the POST /esx/settings/depots/offline?action=createFromHost operation.

This property was added in vSphere API 7.0.2.0.

string As password As password

password

Required

Specifies the password to be used during the POST /esx/settings/depots/offline?action=createFromHost operation.

This property was added in vSphere API 7.0.2.0.

integer As int64 As int64

port

Optional

Specifies the port number of the host to be used during POST /esx/settings/depots/offline?action=createFromHost operation.

This property was added in vSphere API 7.0.2.0.

If missing or null, port number is set to 443.

string

ssl_thumb_print

Optional

This property is deprecated as of vSphere API 9.0.0.0. This field is deprecated and will be removed in future versions. Please use the 'ssl_certificate' field instead.

Specifies the sslThumbPrint of the host to be used during POST /esx/settings/depots/offline?action=createFromHost operation SHA1 hash of the host's SSL certificate.

This property was added in vSphere API 7.0.2.0.

If specified and the server presents that thumbprint, the connection will be established; if missing or null, the connection will only proceed if the server-presented certificate can be validated by specified sslCertificate.

string

ssl_certificate

Optional

Specifies the sslCertificate of the host to be used during POST /esx/settings/depots/offline?action=createFromHost operation PEM format of the host's SSL certificate.

This property was added in vSphere API 9.0.0.0.

If specified and the server presents that certificate, the connection will be established; if missing or null, the connection will only proceed if the server-presented thumbprint can be validated by specified sslThumbprint. Note: sslThumbprint and sslCertificate parameters are mutually exclusive, and should never be used simultaneously. If both are set, this operation will throw InvalidArgument exception.